![]()
version 1.0
This document can also be found online at http://web3canvas.com/builder/docs/index.html
Web3Builder is a Javascript framework which allows users to customise HTML templates in a quick and easy way without writing any code. Web3Builder allows basic content editing, allowing users to changes link text, headers and other written content. It is very helpful for users who doesn't have HTML or CSS Knowlegde.
Web3Builder runs (almost) entirely in the browser. The only server side code is used for previewing & exporting HTML code.
Web3Builder is NOT a CMS (content management system). It does not provide a way for end-users to work on live websites and make changes to such websites.
For more information email me on support@surjithctly.in
Web3Builder can be either installed locally or on live server. For both platforms, you will need a PHP environment with Apache Webserver.
a) Local
b) Live Server
Installing Wamp
Installing Web3Builder Locally
Installing Web3Builder in the server is pretty easy. Please follow the steps below
The Export file will save temporarily in /tmp folder. make sure this folder is writable. You can change the property to (777). Also The Preview file saved in /elements folder and the Uploaded images in /elements/images/upload . So make sure you have given Write permission to these folders.
Editing Template in Web3Builder Splits in to three parts. Sections, contents and details. You'll need to toggle these each time when you edit. Here is a list of things you can do with each mode.
Sections
Contents
Details
Web3Builder allows users to drag HTML elements onto a canvas and drop them where they'd like them to appear. Once dropped onto the canvas, the position can be changed by dragging and dropping as well. Elements can be delete individually or all elements on the current page can be deleted in one go.
The Web3Builder script can also be used to edit written content inside each element (simply by setting the "building mode" to "content"). Web3Builder uses a rich text editor, allowing to make changes to the written content. Depending on what type of element you're editing, certain options will be disabled in the editor.
The Web3Builder script also allows for basic CSS editing and link editing. Using the built-in CSS editor, end-users can customise whatever CSS attributes the script's admin has configured. When editing a link, the end-user can point the link to either an internal page or an (external) URL.
The Web3Builder script allows user to edit links as well. To be able to edit links, firstly select the Details building mode, this will allow you to select links. When selected, a "link" tab will be visible in the left panel, allowing you to either choose a page to link to or enter a URL manually.
Linking within a single page
When building a one-page website, you might want to link to sections within a single page rather then to a separate page. To do this, simply edit the link and use the second dropdown to choose the block you'd like to link to. The ID's to which can be linked, have to be configured within the block HTML files, and the ID attribute should be assigned to the first child element of the main container (for an example, please have a look at any of the bundled block files).
The Web3Builder script allows user to edit images as well. To edit images on the canvas, firstly select the Details building mode, this will allow you to select images. When selected, a "image" tab will be visible in the left panel, allowing you to either upload an image or enter a URL manually.
To change the image, input new image url inside the textbox. To remove the image, just clear the textbox.
To change the video in any section, copy the embed code from youtube or vimeo, then click "Source" button on the section, then replace the current iframe embed code with the new one.
Items which have been setup in the "editableItems" array in /js/builder.js can be cloned. Switch to "Details" building mode, select the item which you want to clone and finally click the clone button from the left panel. Please note that cloned items will be inserted into the canvas right next to the original item.
In some situations, you might want to have the parent of the original item cloned, rather then the item itself. Consider the example of an unsorted list with "a" tags inside "li" tags. In this case, it's the containing "li" element which should be cloned, not the "a" element itself. To make this happen, make sure to add the class name "propClone" to the parent element in your element's .html file. For an example, please have a look at the navigation of the element "header1.html".
Whenever the user is happy with the final result, the created markup can be exported by click the green export button. The export feature will grab all the used HTML elements for each created page. Once all pages are completed, all the HTML files are bundled into a ZIP archive together with the other external resources like stylesheets, Javascript files and images which will be downloaded by the end user.
To preview a page click on the preview button in the top bar, you can only preview a single page; links to other pages won't work. When you make changes to your page, reloading the preview won't work, instead you'll have to use the "Preview" button again.
The Web3Builder script allows users to create multiple pages at once. To add a new page, simply click the green button labeled "+ Add" just below the current pages list. You can alter the page names as well (please use names without the .html extension, these are added automatically during the export). When exporting the markup, the pages will use the same names. To delete a page, simply click the little delete icon next to the page you'd like to delete.
Web3Builder allows you to backup your current project as ".builder" file which you can continue edit later by importing the file in to Web3Builder.
Web3Builder only allows you to edit HTML pages. You should customize Forms manually. Once you have customized the pages, Export it as .zip. Then open it in your local machine. Then you can find php pages. Configure it manually to make it work.